Skip to main content

PUT Start Streaming for Live Video

Overview


The table below provides key details about the PUT method for initiating Live Video Streaming.

PUT Start Streaming for Live Video
MethodPUT
URL or Endpoint/api/v2/projectId/live-videos/id/go-live
HeadersAuthorization
Parametersid, projectId
BodyNot Applicable

The description of the URL parameter is as follows:

id URL Parameter
URL Parameter Nameid
MandatoryYes
Typestring
DescriptionUnique Id of the live video.
projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": true,
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed